/*
 * Copyright (C), 2014-2016, org.esaydev
 * FileName: MenuType.java
 * Author:   jian
 * Date:     2016年3月24日 
 */
package org.easydev.wechat.client.dto.menu;

/**
 * <Description>菜单类型<br>
 * 以下是官方说明：<br>
 * 3到8的所有事件，仅支持微信iPhone5.4.1以上版本，和Android5.4以上版本的微信用户，<br>
 * 旧版本微信用户点击后将没有回应，开发者也不能正常接收到事件推送。<br>
 * 9和10，是专门给第三方平台旗下未微信认证（具体而言，是资质认证未通过）的订阅号准备的事件类型，<br>
 * 它们是没有事件推送的，能力相对受限，其他类型的公众号不必使用。<br>
 * 
 * @author jian<br>
 */
public enum MenuType {

    /**
     * 点击推事件 <br>
     * 用户点击click类型按钮后，微信服务器会通过消息接口推送消息类型为event 的结构给开发者（参考消息接口指南），<br>
     * 并且带上按钮中开发者填写的key值，开发者可以通过自定义的key值与用户进行交互；<br>
     */
    CLICK(1, "click"),
    /**
     * 跳转URL<br>
     * 用户点击view类型按钮后，微信客户端将会打开开发者在按钮中填写的网页URL，<br>
     * 可与网页授权获取用户基本信息接口结合，获得用户基本信息。<br>
     */
    VIEW(2, "view"),
    /**
     * 扫码推事件<br>
     * 用户点击按钮后，微信客户端将调起扫一扫工具，完成扫码操作后显示扫描结果（如果是URL，将进入URL），<br>
     * 且会将扫码的结果传给开发者，开发者可以下发消息。<br>
     */
    SCANCODE_PUSH(3, "scancode_push"),
    /**
     * 扫码推事件且弹出“消息接收中”提示框<br>
     * 用户点击按钮后，微信客户端将调起扫一扫工具，完成扫码操作后，将扫码的结果传给开发者，<br>
     * 同时收起扫一扫工具，然后弹出“消息接收中”提示框，随后可能会收到开发者下发的消息。<br>
     */
    SCANCODE_WAITMSG(4, "scancode_waitmsg"),
    /**
     * 弹出系统拍照发图<br>
     * 用户点击按钮后，微信客户端将调起系统相机，完成拍照操作后，会将拍摄的相片发送给开发者，<br>
     * 并推送事件给开发者，同时收起系统相机，随后可能会收到开发者下发的消息。<br>
     */
    PIC_SYSPHOTO(5, "pic_sysphoto"),
    /**
     * 弹出拍照或者相册发图<br>
     * 用户点击按钮后，微信客户端将弹出选择器供用户选择“拍照”或者“从手机相册选择”。<br>
     * 用户选择后即走其他两种流程。<br>
     */
    PIC_PHOTO_OR_ALBUM(6, "pic_photo_or_album"),
    /**
     * 弹出微信相册发图器<br>
     * 用户点击按钮后，微信客户端将调起微信相册，完成选择操作后，将选择的相片发送给开发者的服务器，<br>
     * 并推送事件给开发者，同时收起相册，随后可能会收到开发者下发的消息。<br>
     */
    PIC_WEIXIN(7, "pic_weixin"),
    /**
     * 弹出地理位置选择器<br>
     * 用户点击按钮后，微信客户端将调起地理位置选择工具，完成选择操作后，将选择的地理位置发送给开发者的服务器，<br>
     * 同时收起位置选择工具，随后可能会收到开发者下发的消息。<br>
     */
    LOCATION_SELECT(8, "location_select"),
    /**
     * 下发消息（除文本消息）<br>
     * 用户点击media_id类型按钮后，微信服务器会将开发者填写的永久素材id对应的素材下发给用户，<br>
     * 永久素材类型可以是图片、音频、视频、图文消息。<br>
     * 请注意：永久素材id必须是在“素材管理/新增永久素材”接口上传后获得的合法id。<br>
     */
    MEDIA_ID(9, "media_id"),
    /**
     * 跳转图文消息URL<br>
     * 用户点击view_limited类型按钮后，微信客户端将打开开发者在按钮中填写的永久素材id对应的图文消息URL，<br>
     * 永久素材类型只支持图文消息。<br>
     * 请注意：永久素材id必须是在“素材管理/新增永久素材”接口上传后获得的合法id。<br>
     */
    VIEW_LIMITED(10, "view_limited");

    /**
     * 事件编码
     */
    private int code;

    /**
     * 事件值
     */
    private String value;

    /**
     * @param code
     * @param value
     */
    private MenuType(int code, String value) {
        this.code = code;
        this.value = value;
    }

    /**
     * get code
     * 
     * @return Returns the code.<br>
     */
    public int getCode() {
        return code;
    }

    /**
     * set code
     * 
     * @param code The code to set. <br>
     */
    public void setCode(int code) {
        this.code = code;
    }

    /**
     * get value
     * 
     * @return Returns the value.<br>
     */
    public String getValue() {
        return value;
    }

    /**
     * set value
     * 
     * @param value The value to set. <br>
     */
    public void setValue(String value) {
        this.value = value;
    }

}
